<!DOCTYPE html>
<html lang="en">
<head>
<title>WebView4Delphi: uWVCoreWebView2ControllerOptions: Class TCoreWebView2ControllerOptions</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0-snapshot">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<span id="TCoreWebView2ControllerOptions"></span><h1 class="cio">Class TCoreWebView2ControllerOptions</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section"><a class="section" href="#PasDoc-Fields">Fields</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uWVCoreWebView2ControllerOptions.html">uWVCoreWebView2ControllerOptions</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCoreWebView2ControllerOptions = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>


<p>This class is a ICoreWebView2ControllerOptions wrapper.

<p>ICoreWebView2ControllerOptions is used to manage profile options that created by 'CreateCoreWebView2ControllerOptions'.

<p></p>
<p>


<p>&lt;see href=&quot;<a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions">https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions</a>&quot;&gt;See the ICoreWebView2ControllerOptions article.)</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TCoreWebView2ControllerOptions</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Fields"></span><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf">FBaseIntf</a></strong>: <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf2">FBaseIntf2</a></strong>: <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions2.html">ICoreWebView2ControllerOptions2</a>;</code></td>
</tr>
</table>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetInitialized">GetInitialized</a></strong>: boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetProfileName">GetProfileName</a></strong>: <a href="uWVTypes.html#wvstring">wvstring</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetIsInPrivateModeEnabled">GetIsInPrivateModeEnabled</a></strong>: boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetScriptLocale">GetScriptLocale</a></strong>: <a href="uWVTypes.html#wvstring">wvstring</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetProfileName-wvstring-">SetProfileName</a></strong>(const aValue : <a href="uWVTypes.html#wvstring">wvstring</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetIsInPrivateModeEnabled-boolean-">SetIsInPrivateModeEnabled</a></strong>(aValue : boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetScriptLocale-wvstring-">SetScriptLocale</a></strong>(const aValue : <a href="uWVTypes.html#wvstring">wvstring</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#Create-ICoreWebView2ControllerOptions-">Create</a></strong>(const aBaseIntf : <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a>); reintroduce;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#Initialized">Initialized</a></strong>             : boolean                        read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetInitialized">GetInitialized</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#BaseIntf">BaseIntf</a></strong>                : <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a> read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf">FBaseIntf</a>                  write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf">FBaseIntf</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#ProfileName">ProfileName</a></strong>             : <a href="uWVTypes.html#wvstring">wvstring</a>                       read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetProfileName">GetProfileName</a>             write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetProfileName-wvstring-">SetProfileName</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#IsInPrivateModeEnabled">IsInPrivateModeEnabled</a></strong>  : boolean                        read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetIsInPrivateModeEnabled">GetIsInPrivateModeEnabled</a>  write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetIsInPrivateModeEnabled-boolean-">SetIsInPrivateModeEnabled</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#ScriptLocale">ScriptLocale</a></strong>            : <a href="uWVTypes.html#wvstring">wvstring</a>                       read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetScriptLocale">GetScriptLocale</a>            write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetScriptLocale-wvstring-">SetScriptLocale</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="FBaseIntf"></span><code><strong>FBaseIntf</strong>: <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="FBaseIntf2"></span><code><strong>FBaseIntf2</strong>: <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions2.html">ICoreWebView2ControllerOptions2</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetInitialized"></span><code>function <strong>GetInitialized</strong>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetProfileName"></span><code>function <strong>GetProfileName</strong>: <a href="uWVTypes.html#wvstring">wvstring</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetIsInPrivateModeEnabled"></span><code>function <strong>GetIsInPrivateModeEnabled</strong>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="GetScriptLocale"></span><code>function <strong>GetScriptLocale</strong>: <a href="uWVTypes.html#wvstring">wvstring</a>;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="SetProfileName-wvstring-"></span><code>procedure <strong>SetProfileName</strong>(const aValue : <a href="uWVTypes.html#wvstring">wvstring</a>);</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="SetIsInPrivateModeEnabled-boolean-"></span><code>procedure <strong>SetIsInPrivateModeEnabled</strong>(aValue : boolean);</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="SetScriptLocale-wvstring-"></span><code>procedure <strong>SetScriptLocale</strong>(const aValue : <a href="uWVTypes.html#wvstring">wvstring</a>);</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create-ICoreWebView2ControllerOptions-"></span><code>constructor <strong>Create</strong>(const aBaseIntf : <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a>); reintroduce;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p class="nodescription">This item has no description.</p></td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Initialized"></span><code>property <strong>Initialized</strong>             : boolean                        read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetInitialized">GetInitialized</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 Returns true when the interface implemented by this class is fully initialized. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="BaseIntf"></span><code>property <strong>BaseIntf</strong>                : <a href="uWVTypeLibrary.ICoreWebView2ControllerOptions.html">ICoreWebView2ControllerOptions</a> read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf">FBaseIntf</a>                  write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#FBaseIntf">FBaseIntf</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 Returns the interface implemented by this class. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="ProfileName"></span><code>property <strong>ProfileName</strong>             : <a href="uWVTypes.html#wvstring">wvstring</a>                       read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetProfileName">GetProfileName</a>             write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetProfileName-wvstring-">SetProfileName</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>


<p>`ProfileName` property is to specify a profile name, which is only allowed to contain the following ASCII characters. It has a maximum length of 64 characters excluding the null-terminator. It is ASCII case insensitive.

<p>* alphabet characters: a-z and A-Z

<p>* digit characters: 0-9

<p>* and '#', '@', '$', '(', ')', '+', '-', '_', '~', '.', ' ' (space).

<p>Note: the text must not end with a period '.' or ' ' (space). And, although upper-case letters are allowed, they're treated just as lower-case counterparts because the profile name will be mapped to the real profile directory path on disk and Windows file system handles path names in a case-insensitive way.

<p></p>
<p>


<p>&lt;see href=&quot;<a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions#get_profilename">https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions#get_profilename</a>&quot;&gt;See the ICoreWebView2ControllerOptions article.)</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IsInPrivateModeEnabled"></span><code>property <strong>IsInPrivateModeEnabled</strong>  : boolean                        read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetIsInPrivateModeEnabled">GetIsInPrivateModeEnabled</a>  write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetIsInPrivateModeEnabled-boolean-">SetIsInPrivateModeEnabled</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
 `IsInPrivateModeEnabled` property is to enable/disable InPrivate mode. </p>
<p>


<p>&lt;see href=&quot;<a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions#get_isinprivatemodeenabled">https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions#get_isinprivatemodeenabled</a>&quot;&gt;See the ICoreWebView2ControllerOptions article.)</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="ScriptLocale"></span><code>property <strong>ScriptLocale</strong>            : <a href="uWVTypes.html#wvstring">wvstring</a>                       read <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#GetScriptLocale">GetScriptLocale</a>            write <a href="uWVCoreWebView2ControllerOptions.TCoreWebView2ControllerOptions.html#SetScriptLocale-wvstring-">SetScriptLocale</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>


<p>The default locale for the WebView2. It sets the default locale for all Intl JavaScript APIs and other JavaScript APIs that depend on it, namely `Intl.DateTimeFormat()` which affects string formatting like in the time/date formats. Example: `Intl.DateTimeFormat().format(new Date())` The intended locale value is in the format of BCP 47 Language Tags. More information can be found from [IETF BCP47](<a href="https://www.ietf.org/rfc/bcp/bcp47.html">https://www.ietf.org/rfc/bcp/bcp47.html</a>).

<p>This property sets the locale for a CoreWebView2Environment used to create the WebView2ControllerOptions object, which is passed as a parameter in `CreateCoreWebView2ControllerWithOptions`.

<p>Changes to the ScriptLocale property apply to renderer processes created after the change. Any existing renderer processes will continue to use the previous ScriptLocale value. To ensure changes are applied to all renderer process, close and restart the CoreWebView2Environment and all associated WebView2 objects.

<p>The default value for ScriptLocale will depend on the WebView2 language and OS region. If the language portions of the WebView2 language and OS region match, then it will use the OS region. Otherwise, it will use the WebView2 language.

<p></p>
<p>


<p>&lt;see href=&quot;<a href="https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions2#get_scriptlocale">https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2controlleroptions2#get_scriptlocale</a>&quot;&gt;See the ICoreWebView2ControllerOptions2 article.)</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>
</body></html>
